home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / ra / raplnk10.zip / RAPLINK.DOC < prev    next >
Text File  |  1994-06-09  |  15KB  |  339 lines
  1.                            RAPLink Version 1.00
  2.                 Copyright (c) 1994 by David Ong, OmniWare
  3.                          Calgary, Alberta, Canada
  4.  
  5.  
  6.                             [ Description ]
  7.  
  8. RAPLink is a teleconference linking program.  Specifically, it links a
  9. RAP (Remote Access Pub) Teleconference to almost any other teleconference
  10. program such as a Major BBS teleconference.
  11.  
  12.  
  13.                             [ Requirements ]
  14.  
  15. RAPLink requires:  70K of memory
  16.                    Remote Access Pub Teleconference (RAP) v1.81 or higher.
  17.                    Fossil Communications Driver loaded
  18.                    Share.exe loaded (or built in share support in the
  19.                      Operating system you are using such as OS/2).
  20.  
  21. Note:              RAPLink will most likely NOT WORK for RAP v1.90 or higher.
  22.                    Once v1.90 is released I will try to get a updated
  23.                    version out ASAP except if Paul Sidorsky finally puts
  24.                    the feature of linking into RAP that I feel is as good or
  25.                    better than RAPLink.
  26.  
  27.  
  28.                               [ Licence ]
  29.  
  30. You may upload RAPLink to any bulletin board, distribute copies to other
  31. users, and use RAPLink provided these conditions are met:
  32.  
  33. 1) You may use RAPLink for a 30 DAY TRIAL PERIOD after which you MUST
  34.    register RAPLink or discontinue using it.
  35. 2) None of the files contained in the archive have been added, deleted, or
  36.    modified in any way prior to being distributed.
  37. 3) There is no charge other than a nominal fee for the diskette and cost
  38.    of sending the program.
  39. 4) Shareware distributors MUST make it clear that they are receiving an
  40.    unregistered EVALUATION copy that requires a registration fee be sent
  41.    to the author after a trial period.
  42. 5) Registered versions of this program ARE NOT TO BE DISTRIBUTED.
  43. 6) This licence may be revoked by David Ong without prior notice.
  44.  
  45.  
  46.                                [ Files ]
  47.  
  48. RAPLINK.EXE      RAPLink program for BBSs running RAP v1.81 or v1.82.
  49. RAPLNEW.EXE      The RAPLink program.  Use with RAP v1.82a or higher.
  50. RAPLOLD.EXE      RAPLink program for BBSs running RAP v1.81 or v1.82.
  51. RAPLINK.DOC      This file.  Documentation for RAPLink.
  52. REGISTER.FRM     Registration form.
  53. README.1ST       Important program information.
  54. HISTORY.DOC      Program history.
  55. DONTSHOW.TXT     Sample file used with RAPLink.
  56. FILE_ID.DIZ      BBS ad file.
  57.  
  58. *** WARNING: Do not PKLITE, LZEXE or do any similar thing to RAPLink.
  59.              Doing so will corrupt the program! RAPLink writes its
  60.              configuration directly to the RAPLINK.EXE file.
  61.  
  62. It is recommended you put these files in a seperate directory from RAP.
  63.  
  64. ***************************** MUST DO ********************************
  65. ***  If you are using RAP v1.82a or higher then copy RAPLNEW.EXE   ***
  66. ***  over RAPLINK.EXE                                              ***
  67. ***  Command Line> COPY RAPLNEW.EXE RAPLINK.EXE                    ***
  68. **********************************************************************
  69.  
  70.  
  71.                         [ Configuring RAPLink ]
  72.  
  73. Run RAPLink with a /CONFIG parameter to access the configuration manual.
  74.  
  75. Command line> RAPLINK /CONFIG
  76.  
  77. You will be able to configure these options by using the up/down cursor
  78. keys to move to the option you wish to change.  Then hit enter to change
  79. that option.
  80. -------------------------------------------------------------------------
  81. Your BBS Name
  82.   - This is the name of your BBS system.
  83.  
  84. Ansi Stripping
  85.   - If this is set to ON, RAPLink will remove all ANSI coming from the
  86.     BBS you have linked to.
  87.  
  88. RAP Code Sending
  89.   - If this is set to ON, RAPLink will send RAP colour codes to the BBS
  90.     you have linked to.  This should be set ON if you are connect to
  91.     another RAP teleconference.
  92.  
  93. Show BBS Name
  94.   - When turned ON, the name of the BBS is displayed in front of the text
  95.     received from that BBS.  RAPLink usually looks better with this
  96.     setting turn OFF, but can be confusing to the users especially if
  97.     RAPLink is connected to another RAP teleconference.
  98.  
  99. Sending Delay
  100.   - Some teleconference programs cannot received data at the rate RAPLink
  101.     sends it.  If this is true of the teleconference RAPLink is linked to
  102.     make sure this setting is set to a suitablely long delay.  For RAP
  103.     systems a delay of 7ms works well.
  104.  
  105. Checking Delay
  106.   - In order to reduce the stress on a multi-tasking or network system
  107.     RAPLink can be set to delay for a certain number of seconds between
  108.     checking incoming text from the linked BBS, and incoming text from
  109.     local useres.  If this setting is set to 0, RAPLink will continuously
  110.     be checking for incoming messages.
  111.  
  112. Direct Text
  113.   - This can be used to turn off access to direct text.  Direct
  114.     text is text from the user that is sent exactly as the user
  115.     writes it.  No braces "[]" or any other text is added to it.
  116.  
  117. BBS Commands
  118.   - RAPLink has commands which the linked BBS can send.  If you do not
  119.     want them to be able to, turn this option to OFF.
  120.  
  121. Give Time Slices
  122.   - When there is no incoming text from the linked BBS and no incoming
  123.     text from the local users, RAPLink will give up time slices to the
  124.     operating system.  This can help overall system performance on a
  125.     multitasked PC.
  126. -------------------------------------------------------------------------
  127.  
  128. After you have set the options to your preference press the <ESC> key.
  129. You will be prompted as to if you want to save the settings.  Type "Y"
  130. if you want them saved, "N" if you don't.
  131.  
  132.  
  133.                         [ DONTSHOW.TXT File ]
  134.  
  135. Any message you don't want displayed from the other BBS should be added
  136. to this file.  Usually message sent text is ignored since it adds a lot
  137. of extra clutter.  Up to 50 lines can be placed in the DONTSHOW.TXT file
  138. with an ASCII text editor.
  139.  
  140. Sample DONTSHOW.TXT file:
  141. -Sent-
  142. -- Message Sent --
  143. -- Sent --
  144.  
  145. The file must be placed in the SAME directory RAPLink is in.
  146.  
  147.  
  148.                          [ Linking to a BBS ]
  149.  
  150. First of all, make sure RAP HAS BEEN RUN PREVIOUSLY OR IS RUNNING.  RAPLink
  151. will not initialize/create the NODEIDX.RAP and NODEIDX2.RAP files.
  152.  
  153. Then call the BBS you want to link to using any terminal program that
  154. allows you to shell to DOS.  Enter the BBS's teleconference and shell
  155. to DOS.  Then run RAPLink with these parameters:
  156. =========================================================================
  157. RAPLink <com port> <BBS Name> <RAP work path> [<node>]
  158.  
  159. <comport>    Is the com port you are going to use.
  160.              COM1 = 1, COM2 = 2, etc.
  161. <BBS Name>   Is the name of the BBS (Only one word!) you are linking too
  162. <work path>  Is the path to RAP's work directory.
  163. <node>       Is optional and if given will FORCE RAPLink to use the node even
  164.              if it is already taken.
  165.              (Good for re-claiming a node after a session crash)
  166.  
  167. Example:
  168. Command Line> RAPLINK 2 Quantum d:\rap\workdir
  169. =========================================================================
  170.  
  171.  
  172.                     [ While RAPLink is Running ]
  173.  
  174. RAPLink will load and a Pub entry message should appear to all the RAP users.
  175. The screen should look something like this once RAPLink has started:
  176. *****************************************************************************
  177.           RAPLink v1.00 (c) 1994 by David Ong, All Rights Reserved.
  178. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  179. ░┌── Com Port: 2 ─────────────────────────────────────── Node: 3 ───┬────┐░░░
  180. ░│[ RAPLink v1.00 Activated ]                                       │Sent│░░░
  181. ░│[ RAPLink v1.00 Activated ]                                       │Rcvd│░░░
  182. ░│                                                                  │    │░░░
  183. ░│                                                                  │    │░░░
  184. ░│                                                                  │    │░░░
  185. ░│                                                                  │    │░░░
  186. ░│                                                                  │    │░░░
  187. ░│                                                                  │    │░░░
  188. ░│                                                                  │    │░░░
  189. ░│                                                                  │    │░░░
  190. ░│                                                                  │    │░░░
  191. ░│                                                                  │    │░░░
  192. ░│                                                                  │    │░░░
  193. ░│                                                                  │    │░░░
  194. ░│                                                                  │    │░░░
  195. ░├──────────────────────────────────────────────────────────────────┴────┤░░░
  196. ░│L)inked to: Quantum                                                    │░░░
  197. ░│A)nsi Stripping is: Off           B)BS Name Displaying is: On          │░░░
  198. ░│S)end RAP codes: Off              D)irect Text is: On                  │░░░
  199. ░└───────────────────────────────────────────────────────────────────────┘░░░
  200. ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  201.  <ESC> Exits RAPLink and disengages the link                   Unregistered
  202. *****************************************************************************
  203.  
  204. The window displays what RAPLink sends or receives from the com port and what
  205. it does to it shown by the right hand section of the window.
  206.  
  207. These are the codes and what they mean:
  208. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  209. Sent - Text that is sent to the other BBS.
  210. Rcvd - Text received from the other BBS but not broadcasted to the local RAP
  211.        users.
  212. Brod - Text received from the other BBS and is broadcasted to the local
  213.        RAP users.
  214. DTxt - Direct text sent from a local user.  No braces "[]" or any other text
  215.        is added to it.
  216. -Who - Sending response from a (RAP:WHO) command issued by the linked BBS.
  217. -Ver - Sending response from a (RAP:VER) command issued by the linked BBS.
  218.  
  219. Availible commands in the RAPLink session:
  220. -------------------------------------------------------------------------
  221. Key to press                       What it Does
  222.      L                 Change the name of the link.
  223.      A                 Toggles ANSI stripping of incoming text.
  224.      B                 Toggles display of linked BBS Name to local users.
  225.      S                 Toggles sending of RAP colour codes to linked BBS.
  226.      D                 Toggles ability of local users to send text
  227.                        directly to the linked BBS.
  228.     ESC                Exits RAPLink
  229.    Alt-J               Shells to DOS.
  230. -------------------------------------------------------------------------
  231.  
  232.  
  233.                         [ Commands for Users ]
  234.  
  235. By typing text as usual, RAPLink will send it over the modem to the linked
  236. BBS.  Actions, talktypes, profile editor enter/exiting, and many other
  237. things are sent to the linked BBS.
  238.  
  239. Direct text can be sent to the linked BBS by a user by whipsering to the
  240. link and putting a "*" before the text.
  241. eg:
  242. Rebel: /q *poker scan
  243.  
  244. Commands from the other BBS can be sent to RAPLink.  There are currently
  245. two commands availible.  They must be enclosed with the braces "()".
  246. (RAP:WHO) - Shows who is in RAP at the moment.
  247. (RAP:VER) - Shows version and copyright of RAPLink.
  248.  
  249.  
  250.                          [ Acknowledgements ]
  251.  
  252. I'd like to thank these people who helped in the development of RAPLink.
  253.  
  254. Paul Sidorsky - Programming the new versions of RAP, providing me with RAP
  255.                 file structures, not suing for taking his RAPLink
  256.                 trademark :) and beta-testing RAPLink even in its earlier
  257.                 "pathetic" versions (v0.11-v0.14).
  258.  
  259. Joe Lindstrom - Having the original idea of RAP and beta-testing/putting up
  260.                 with earlier versions of RAPLink that didn't like running
  261.                 on his system.
  262.  
  263. Quantum BBS users - For putting up with all the beta-testing :-)
  264.  
  265.  
  266.                             [ Disclaimer ]
  267.  
  268.   This software and accompanying materials are distributed "as is" without
  269. warranty, expressed or implied; including but not limited to any implied
  270. warranties of merchantability or fitness for a particular purpose. In no
  271. event shall David Ong, OmniWare or anyone involved with the creation
  272. and production of this product be held liable for any damages, including,
  273. but not limited to, any lost profits, savings, data or other incidental,
  274. indirect, special, or consequential damages arising out of the use or
  275. inability to use this software, or for any claim by any other party, even
  276. if David Ong or OmniWare have been advised of the possibility of such
  277. damages. The person using the software bears all risk as to the quality
  278. and performance of the software.
  279.  
  280.  
  281.                      [ Copyright Acknowledgements ]
  282.  
  283. This document may have mentioned other products.  All copyrights,
  284. trademarks and reserved rights held by these products are acknowledged.
  285. All trademarks and registered trademarks belong to their respective owners.
  286.  
  287.  
  288.                         [ Registering RAPLink ]
  289.  
  290. RAPLink is shareware.  If you use RAPLink for more than a 30 DAY TRIAL
  291. PERIOD you MUST register it or discontinue using RAPLink.
  292.  
  293. Registering RAPLink costs $10 Canadian currency for a non-commercial
  294. user and $15 for a commercial user.
  295.  
  296. You are a NONCOMMERCIAL user only if you are running your BBS as a
  297. private individual with no "sponsors", "backers", and your BBS
  298. is not making a profit.
  299.  
  300. You are a COMMERCIAL user if you make a profit from running
  301. your BBS, or if your BBS is being run by (or for) a corporation,
  302. government, company, foundation, church, or any other organization.
  303.  
  304. RAPLink is NOT CRIPPLED (I don't like crippling my software), but does
  305. have "reminders" that it is unregistered.  Registering RAPLink will remove
  306. all these reminders that RAPLink.
  307.  
  308. **************************************************************************
  309. *Print out REGISTER.FRM, complete the form and mail to the address shown!*
  310. **************************************************************************
  311.  
  312.  
  313.                         [ Reaching the author ]
  314.  
  315. Please report any bugs and feel free to send comments/suggestions!
  316.  
  317. Mail Networks:
  318.  
  319.   FidoNet - 1:134/31
  320.   MetroNet - 201:5500/31
  321.   InterNet - David.Ong@f31.n5500.z201.cpubbs.cuug.ab.ca
  322.   Or call C.R.I.S.I.S. HQ BBS directly (403)686-0449 and leave a message
  323.   to me (David Ong) in the OmniWare Support Echo.
  324.  
  325. I can sent FidoNet and InterNet will be replied to, but MetroNet netmail
  326. will be placed on hold for you to pick up.
  327.  
  328. Or send mail to:   David Ong
  329.                    858 Queensland Drive SE
  330.                    Calgary, AB, Canada
  331.                    T2J 6J4
  332.  
  333. The latest version of RAPLink can be downloaded/freqed from
  334. C.R.I.S.I.S HQ BBS (403) 686-0449 (Calgary, Ab).
  335.  
  336. Use the magic name CATALOG to freq the OmniWare catalog of all
  337. our products.  The current version of RAPLink can be freqed under the magic
  338. name RAPLINK.
  339.